APIBillingServiceglobal with sharing class APIBillingService EnumsObjectTypesRelease
ObjectTypesRemove
ObjectTypesClear
Methods
generateglobal static APICommonsService.BatchStatus generate(APIBillingService.BillingContextGenerate bc) Generates billing events using the values in the input parameters Input Parameters
Return ValueThis method returns an APICommonsService.BatchStatus object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code releaseglobal static APICommonsService.BatchStatus release(APIBillingService.BillingContextRelease bc) Validates that all billing events are in an unreleased state and executes the FinancialForce PSA release process for the billing events specified in the input parameters. Input Parameters
Return ValueThis method returns a APICommonsService.BatchStatus object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code invoiceglobal static APICommonsService.BatchStatus invoice(APIBillingService.BillingContextInvoice bc) Validates that all billing events specified in the input parameters are unreleased and are not invoiced and then executes the FinancialForce PSA invoice process for the billing events specified in the input parameters. Input Parameters
Return ValueThis method returns an APICommonsService.BatchStatus object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code recalcglobal static APICommonsService.BatchStatus recalc(APIBillingService.BillingContextRecalc bc) Validates whether all billing events are in an unreleased state and executes the FinancialForce PSA recalc process for the billing events specified in the input parameters. Input Parameters
Return ValueThis method returns a APICommonsService.BatchStatus object. removeglobal static APICommonsService.BatchStatus remove(APIBillingService.BillingContextRemove bc) Removes billing events using the parameters specified. This deletes unreleased billing events or billing event items belonging to unreleased billing event items depending on the input provided. Input Parameters
Return ValueThis method returns an APICommonsService.BatchStatus object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code clearglobal static APICommonsService.BatchStatus clear(APIBillingService.BillingContextClear bc) Clears the billing data for the objects specified in the input parameters. Input Parameters
Return ValueThis method returns a APICommonsService.BatchStatus object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code scheduleglobal static APICommonsService.BatchStatus schedule(APIBillingService.BillingContextSchedule bc) Schedules billing event generation using the input parameters specified. Input Parameters
Return ValueThis method returns an APICommonsService.BatchStatus object with a status of either Error or Scheduled. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code statusglobal static APICommonsService.BatchStatus status(ID jobID) Returns the status of the job from the job's object status field. Input Parameters
Return ValueThis method returns an APICommonsService.BatchStatus object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code fetchglobal static APIBillingService.BillingResults fetch(APIBillingService.BillingContextFetch bc) Returns a list of billing event batches. The billing event batches returned are filtered depending on the values specified in the input parameters. Input Parameters
Return ValueThis method returns a APIBillingService.BillingResults object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code APIBillingService.BillingContextGenerateglobal class BillingContextGenerate extends APICommonsService.BatchContext a structure containing the criteria on which to generate billing events. this class/type extends apicommonsservice.batchcontext This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingContextReleaseglobal class BillingContextRelease extends APICommonsService.BatchContext a structure containing a list of ids of billing events belonging to unreleased billing events to be released. this class/type extends apicommonsservice.batchcontext. This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingContextInvoiceglobal class BillingContextInvoice extends APICommonsService.BatchContext a structure containing a list of invoice information for billing events that are to be invoiced. This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingContextRecalcglobal class BillingContextRecalc extends APICommonsService.BatchContext a structure containing a list of ids of unreleased billing events on which to recalculate billing data for. this class/type extends apicommonsservice.batchcontext. This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingContextRemoveglobal class BillingContextRemove extends APICommonsService.BatchContext a structure containing a list of ids of billing records belonging to unreleased billing events to be removed. This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingContextClearglobal class BillingContextClear extends APICommonsService.BatchContext a structure containing an id of a billing record belonging to unreleased billing events to clear billing data for. This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingContextScheduleglobal class BillingContextSchedule extends APICommonsService.BatchContext a structure containing the criteria on which to schedule billing event generation. This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingContextFetchglobal class BillingContextFetch extends APICommonsService.BatchContext a structure containing the criteria on which to filter billing data when retrieving billing event batches. This class extends APICommonsService.BatchContext Properties
APIBillingService.BillingResultsglobal class BillingResults a structure containing a list of billing event batch containers returned by apibillingservice.fetch. Properties
APIBillingService.BEBContainerglobal class BEBContainer a structure containing a billing event batch and a billing event container that contains the billing events for that billing event batch. Properties
APIBillingService.BEContainerglobal class BEContainer a structure within a bebcontainer that contains a billing event and a list of billing event items which belong to that billing event. Properties
APIBillingService.DefaultBillingGenerateHandlerglobal class DefaultBillingGenerateHandler implements APICommonsService.iBatchCallback a structure containing the methods in the ibatchcallback interface that hook into the billing generate process. see "interface: ibatchcallback". This class implements the following interfaces: Methods
beforeStartglobal void beforeStart(APICommonsService.BatchContext bc) This method is called before the logic of the Start method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code afterStartglobal void afterStart(APICommonsService.BatchContext bc) This method is called after the logic of the Start method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code beforeExecuteglobal void beforeExecute(APICommonsService.BatchContext bc, Set<ID> scope) This method is called before the logic of the Execute method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code afterExecuteglobal void afterExecute(APICommonsService.BatchContext bc, Set<ID> scope) This method is called after the logic of the Execute method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code beforeFinishglobal void beforeFinish(APICommonsService.BatchContext bc) This method is called before the logic of the Finish method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code getJobTypeglobal APICommonsService.BatchJobType getJobType() This method must be implemented by the creator of any class that implements the iBatchCallback interface. This indicates the FinancialForce PSA billing process that the class is to intends to implement. These FinancialForce PSA billing processes all confirm that the implemented type matches their identity: Return ValueThis method returns an APICommonsService.BatchJobType object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code afterFinishglobal void afterFinish(APICommonsService.BatchContext bc) This method is called after the logic of the Finish method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code APIBillingService.DefaultBillingReleaseHandlerglobal inherited sharing class DefaultBillingReleaseHandler implements APICommonsService.iBatchCallback a structure containing the methods in the ibatchcallback interface that hook into the billing release process. see "interface: ibatchcallback". This class implements the following interfaces: Methods
beforeStartglobal void beforeStart(APICommonsService.BatchContext bc) This method is called before the logic of the Start method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code afterStartglobal void afterStart(APICommonsService.BatchContext bc) This method is called after the logic of the Start method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code beforeExecuteglobal void beforeExecute(APICommonsService.BatchContext bc, Set<ID> scope) This method is called before the logic of the Execute method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code afterExecuteglobal void afterExecute(APICommonsService.BatchContext bc, Set<ID> scope) This method is called after the logic of the Execute method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code beforeFinishglobal void beforeFinish(APICommonsService.BatchContext bc) This method is called before the logic of the Finish method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code getJobTypeglobal APICommonsService.BatchJobType getJobType() This method must be implemented by the creator of any class that implements the iBatchCallback interface. This indicates the FinancialForce PSA billing process that the class is to intends to implement. These FinancialForce PSA billing processes all confirm that the implemented type matches their identity: Return ValueThis method returns an APICommonsService.BatchJobType object. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code afterFinishglobal void afterFinish(APICommonsService.BatchContext bc) This method is called after the logic of the Finish method of a batch is processed. Input Parameters
Return ValueThis method does not return a value. Sample Code//Note: This sample code is for demonstration purposes only. It is not intended for //use in a production environment, is not guaranteed against defects or errors, and //is in no way optimized or streamlined. You need to provide some sample code |